.. _`Rename columns in Tables with Table`:

.. _`org.sysess.sympathy.data.table.renametablecolumnstable`:

Rename columns in Tables with Table
```````````````````````````````````

.. image:: rename_columns.svg
   :width: 48







Documentation
:::::::::::::

Rename columns from the input data using a lookup table.

The lookup table must include one column with search keywords and another
column with replacements. When the node is executed all column names in the
input data are checked against keyword column in the lookup table. If a
match is found the corresponding name in the replacement column will
replace the original column name.  For the case with no match the column
names are left unchanged.

If a name appears more than once in the search column of the lookup, that
column will be renamed to each of the replacement names.  Essentially
copying the single input column to several columns in the output.

If a name appears more than once in the replacements column the last one
that is also present in the input data will be used. Also note that renamed
columns always take precedence over non-renamed ones.


Definition
::::::::::


Input ports
...........

    **dictionary**  table
        Lookup

    **tables**  [table]
        Data


Output ports
............

    **tables**  [table]
        Data




Configuration
.............

    **Replace column** (destination)
        Column containing names to replace with
    **Search column** (source)
        Column containing names to search for





Related nodes
.............

* :ref:`org.sysess.sympathy.data.table.renamesingletablecolumns`

* :ref:`org.sysess.sympathy.setcolumnnamesintablewithtable`




Examples
........

* :download:`RenameColumnsInTable.syx </Examples/Sympathy/Data Processing/Structure/RenameColumnsInTable.syx>`




Implementation
..............

.. automodule:: node_rename_columns
    :noindex:

.. class:: RenameTableColumnsTables
    :noindex: